Package-level declarations

Types

Link copied to clipboard
@Serializable
data class AccelerationMeasurement(val time: Instant, val acceleration: Acceleration, val sensorIdentifier: String, val dataType: SensorDataType = SensorDataType.Acceleration) : InstantaneousMeasurement
Link copied to clipboard
@Serializable
@SerialName(value = "active_calories")
data class ActiveCaloriesRecord(val startTime: Instant, val endTime: Instant, val energy: Double) : IntervalRecord

Captures the user's active calories burned.

Link copied to clipboard
@Serializable
data class AirPressureMeasurement(val time: Instant, val pressure: Pressure, val altitude: Double? = null, val sensorIdentifier: String) : InstantaneousMeasurement
Link copied to clipboard
@Serializable
data class AmbientTemperatureMeasurement(val time: Instant, val temperature: Temperature, val sensorIdentifier: String) : InstantaneousMeasurement

Captures the ambient temperature.

Link copied to clipboard
class AndroidNfcManager(activity: Activity) : NfcAdapter.ReaderCallback, KoinComponent
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class AndroidSensorManager(context: Context) : SensorManager, KoinComponent
Link copied to clipboard
Link copied to clipboard
@Serializable
data class AuthorizationRequest(val username: String, val password: String)
Link copied to clipboard
@Serializable
data class AuthorizationResponse(val transactionId: String? = null, val message: String? = null)
Link copied to clipboard
Link copied to clipboard
@Serializable
@SerialName(value = "blood_glucose")
data class BloodGlucoseRecord(val time: Instant, val level: Double) : InstantaneousRecord

Captures the user's blood glucose level.

Link copied to clipboard
@Serializable
@SerialName(value = "blood_pressure")
data class BloodPressureRecord(val time: Instant, val systolic: Double, val diastolic: Double) : InstantaneousRecord

Captures the user's blood pressure.

Link copied to clipboard
@Serializable
@SerialName(value = "body_fat_percentage")
data class BodyFatPercentageRecord(val time: Instant, val percentage: Double) : InstantaneousRecord

Captures the user's body fat percentage.

Link copied to clipboard
Link copied to clipboard
interface DataSyncManager
Link copied to clipboard
class DataSyncWorker(appContext: Context, workerParams: WorkerParameters) : CoroutineWorker, KoinComponent
Link copied to clipboard
typealias DefaultActionAsync = suspend () -> Unit
Link copied to clipboard
@Serializable
@SerialName(value = "distance")
data class DistanceRecord(val startTime: Instant, val endTime: Instant, val distance: Double) : IntervalRecord

Captures the distance traveled by the user.

EventBus
Link copied to clipboard
class EventBus
class EventBus
FederatedJobWorker
Link copied to clipboard
class FederatedJobWorker(appContext: Context, workerParams: WorkerParameters) : CoroutineWorker
FederatedLearningImports
Link copied to clipboard
FederatedLearningManager
Link copied to clipboard
class FederatedLearningManager(context: Context, hubroSession: HubroSessionBuilder) : FederatedManager
class FederatedLearningManager(hubroSession: HubroSessionBuilder) : FederatedManager
Link copied to clipboard
Link copied to clipboard
@Serializable
data class FirebaseTokenRequest(val token: String, val validUntil: Long)
Link copied to clipboard
class ForbiddenException(exception: String) : Throwable
Link copied to clipboard
class HealthConnectManager(context: Context) : HealthManager
Link copied to clipboard
@Serializable
sealed interface HealthDataType
Link copied to clipboard
interface HealthManager
Link copied to clipboard
@Serializable
sealed class HealthRecord

Common interface shared by readable or writable records.

Link copied to clipboard
data class HeapUsage(val used: Long, val max: Long, val description: String)
Link copied to clipboard
@Serializable
@SerialName(value = "heart_rate")
data class HeartRateRecord(val time: Instant, val beatsPerMinute: Long) : InstantaneousRecord

Captures the user's heart rate.

Link copied to clipboard
@Serializable
@SerialName(value = "height")
data class HeightRecord(val time: Instant, val height: Double) : InstantaneousRecord

Captures the user's height.

Link copied to clipboard
class HubroSession(baseUrl: String, tokenVerifier: String)
Link copied to clipboard
class HubroSessionBuilder(baseUrl: String, tokenVerifier: String) : KoinComponent

This is a KDoc comment.

Link copied to clipboard
@Serializable
@SerialName(value = "hydration")
data class HydrationRecord(val startTime: Instant, val endTime: Instant, val volume: Double) : IntervalRecord

Captures the user's hydration level.

Link copied to clipboard
Link copied to clipboard
@Serializable
sealed interface InstantaneousMeasurement : SensorMeasurement
Link copied to clipboard
@Serializable
sealed class InstantaneousRecord : HealthRecord

A record that contains an instantaneous measurement.

Link copied to clipboard
@Serializable
sealed class IntervalRecord : HealthRecord

A record that contains a measurement with a time interval.

Link copied to clipboard
class IOSDataSyncManager(hubroSession: HubroSessionBuilder) : DataSyncManager
Link copied to clipboard
class IOSPlatform : Platform
Link copied to clipboard
@Serializable
data class LocationMeasurement(val time: Instant, val latitude: Double, val longitude: Double, val altitude: Double? = null, val sensorIdentifier: String) : InstantaneousMeasurement
Link copied to clipboard
actual class ManagerFactory
expect class ManagerFactory
actual class ManagerFactory
actual class ManagerFactory
Link copied to clipboard
@Serializable
class Mass : Comparable<Mass>

Represents a unit of mass. Supported units:

Link copied to clipboard
object MassSerializer : KSerializer<Mass>
Link copied to clipboard
interface NfcViewModel
NumberOfRecordsRequest
Link copied to clipboard
class NumberOfRecordsRequest(val type: Number, val from: Number, val to: Number)
class NumberOfRecordsRequest(val type: Number, val from: Number, val to: Number)
Link copied to clipboard
@Serializable
@SerialName(value = "oxygen_saturation")
data class OxygenSaturationRecord(val time: Instant, val percentage: Double) : InstantaneousRecord

Captures the user's oxygen saturation level.

Link copied to clipboard
interface Platform
Link copied to clipboard
@Serializable
data class Questionnaire(val name: String, val accessLink: String)
RecordsRequest
Link copied to clipboard
class RecordsRequest(val type: Number, val from: Number, val to: Number)
class RecordsRequest(val type: Number, val from: Number, val to: Number)
Link copied to clipboard
@Serializable
data class RefreshTokenRequest(val accessToken: String, val refreshToken: String)
Link copied to clipboard
data class SampleSpec<X, Y>(val convertX: (List<X>) -> Array<X>, val convertY: (List<Y>) -> Array<Y>, val emptyY: (Int) -> Array<Y>)
Link copied to clipboard
@Serializable
sealed interface SensorDataType
Link copied to clipboard
class SensorKitManager : SensorManager, KoinComponent
Link copied to clipboard
class SensorListener(sensorIdentifierProvider: () -> String) : SensorEventListener, KoinComponent
Link copied to clipboard
interface SensorManager
Link copied to clipboard
@Serializable
sealed interface SensorMeasurement
Link copied to clipboard
@Serializable
@SerialName(value = "sleep")
data class SleepRecord(val startTime: Instant, val endTime: Instant, val stage: Int) : IntervalRecord

Captures the user's sleep data.

Link copied to clipboard
@Serializable
@SerialName(value = "steps")
data class StepsRecord(val startTime: Instant, val endTime: Instant, val count: Int) : IntervalRecord

Captures the number of steps taken since the last reading. Each step is only reported once so records shouldn't have overlapping time. The start time of each record should represent the start of the interval in which steps were taken.

Link copied to clipboard
class SystemPermissionActivity : ComponentActivity
Link copied to clipboard
@Serializable
class Temperature : Comparable<Temperature>
Link copied to clipboard
@Serializable
data class TokenResponse(val accessToken: String, val refreshToken: String)
Link copied to clipboard
@Serializable
data class UsageTrackingRecord(val timestamp: Long, val event: String)
Link copied to clipboard
@Serializable
data class UsageTrackingRequest(val events: List<UsageTrackingRecord>)
Link copied to clipboard
@Serializable
data class VerificationRequest(val transactionId: String, val code: String)
Link copied to clipboard
@Serializable
@SerialName(value = "weight")
data class WeightRecord(val time: Instant, val weight: Mass) : InstantaneousRecord

Captures the user's weight.

WorkManagerDataSyncManager
Link copied to clipboard
class WorkManagerDataSyncManager(context: Context, hubroSession: HubroSessionBuilder) : DataSyncManager
class WorkManagerDataSyncManager : KoinComponent

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Creates Mass with the specified value in grams.

Link copied to clipboard

Creates Mass with the specified value in kilograms.

Link copied to clipboard

Creates Mass with the specified value in micrograms.

Link copied to clipboard

Creates Mass with the specified value in milligrams.

Link copied to clipboard

Creates Mass with the specified value in ounces.

Link copied to clipboard

Creates Mass with the specified value in pounds.

Functions

Link copied to clipboard
actual fun getHeapUsage(): HeapUsage?
expect fun getHeapUsage(): HeapUsage?
actual fun getHeapUsage(): HeapUsage?
actual fun getHeapUsage(): HeapUsage?
Link copied to clipboard
actual fun getPlatform(): Platform
expect fun getPlatform(): Platform
actual fun getPlatform(): Platform
actual fun getPlatform(): Platform
Link copied to clipboard
suspend fun requestLocation(sensorIdentifier: String): LocationMeasurement
Link copied to clipboard